<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/sync_io/native_handle_transport.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li><li class="navelem"><a class="el" href="dir_00580eb0cf40d799755587f5d56ed1cf.html">sync_io</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">native_handle_transport.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="sync__io_2native__handle__transport_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment">// Not compiled: for documentation only.  Contains concept docs as of this writing.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#ifndef IPC_DOXYGEN_ONLY</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;As of this writing this is a documentation-only \&quot;header\&quot; &quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>                       <span class="stringliteral">&quot;(the \&quot;source\&quot; is for humans and Doxygen only).&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#else </span><span class="comment">// ifdef IPC_DOXYGEN_ONLY</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1sync__io.html">ipc::transport::sync_io</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">/**</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * A documentation-only *concept* defining the behavior of an object that is the `sync_io`-pattern counterpart</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * of the async-I/O-pattern-following concept of the same name in our parent namespace: transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * This is paired with the sync_io::Native_handle_receiver concept which defines reception of such messages.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> *</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * @see transport::Native_handle_sender -- our async-I/O counterpart.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * @see util::sync_io doc header -- describes the general `sync_io` pattern we are following here.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * ### Concept contents ###</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * The concept defines the following behaviors/requirements.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *   - The object has at least 2 states: Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *   - The (outgoing) transmission-of-messages methods, including transmission of graceful-close message.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *     See their doc headers.  Same signatures as transport::Native_handle_sender methods but acting per</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *     `sync_io` pattern (synchronously).</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *   - Behavior when the destructor is invoked.  See its doc header.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *   - All ctors and move assignment: Same notes as for transport::Native_handle_sender.  Exception: no</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *     `sync_io`-core-adopting ctor (since we *are* that core).</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *   - `sync_io`-pattern setup methods: replace_event_wait_handles(), start_send_native_handle_ops().</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * The concept (intentionally) does *not* define the following behaviors:</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *   - How to create a Native_handle_sender, except the default and move ctors.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *     Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * @see sync_io::Native_socket_stream: as of this writing one key class that implements this concept (and also</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *      sync_io::Native_handle_receiver) -- using the Unix domain socket transport.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * For a given `*this`, it is not required to be safe for a non-`const` operation to be invoked concurrently with</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * another operation.  That&#39;s typical.  *In addition* -- and this is significant -- the following operation shall</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * count as a &quot;non-`const` operation&quot; (as opposed to the usual definition which is simply non-`const` methods and</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * related free functions):</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *   - `(*on_active_ev_func)()`, where `on_active_ev_func` is the so-named argument passed into an invocation of</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *     the `Event_wait_func` the user registers via start_send_native_handle_ops().</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * Therefore: If you report an active event to `*this` (per `sync_io` pattern) from thread 1, and possibly</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * call methods such as `send_native_handle()` from thread 2, then you must use a mutex (or strand or ...)</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * to prevent concurrent execution.  For example: transport::Native_socket_stream, which internally operates</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * a sync_io::Native_socket_stream, uses a send-ops mutex (`transport::Native_socket_stream::Impl::m_snd_mutex`).</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * ### Rationale: Why is send_native_handle() not asynchronous? ###</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> */</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">   73</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>{</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"></span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">  /// Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a624a0c63efc9487cea6da342be38d9a7">   79</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a624a0c63efc9487cea6da342be38d9a7">S_RESOURCE_TYPE_ID</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"></span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   * Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">   */</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a935bfba8ac18f395eb920224395cbc8f">   87</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a935bfba8ac18f395eb920224395cbc8f">Native_handle_sender</a>();</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"></span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">   * Move-constructs from `src`; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">   */</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa99ee4ded3b81cbaea9cb7aeac52a896">   96</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa99ee4ded3b81cbaea9cb7aeac52a896">Native_handle_sender</a>(<a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp;&amp; src);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"></span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">  /// Disallow copying.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#af3efe9a668e251175e5e199e99f9257d">   99</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#af3efe9a668e251175e5e199e99f9257d">Native_handle_sender</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"></span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it&#39;s</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   * still active) and return resources to OS as applicable.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   */</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a59dff09b6ab224e32a096c97b629d059">  105</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a59dff09b6ab224e32a096c97b629d059">~Native_handle_sender</a>();</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"></span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">   * Move-assigns from `src`; `*this` acts as if destructed; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   * No-op if `&amp;src == this`.  Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   *</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   */</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa739a0a76b4e0325c4067d5a5b55a802">  117</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa739a0a76b4e0325c4067d5a5b55a802">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp;&amp; src);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"></span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">  /// Disallow copying.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa67027b6f36ea618586cd24028f5025f">  120</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa67027b6f36ea618586cd24028f5025f">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">Native_handle_sender</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>  <span class="comment">// `sync_io`-pattern API.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"></span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">   * To be (optionally) invoked before any `start_*_ops()`, supplies a factory for the</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * util::sync_io::Asio_waitable_native_handle objects pointers to which shall be subsequently passed into</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   * any `Event_wait_func` (as registered via `start_*_ops()`), when `*this` requires an async-wait on</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * a particular native-handle.  This is useful if the user event loop is built on boost.asio: the supplied factory</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   * function can associate the handle-object with the user&#39;s `Task_engine` (or strand or ...); hence</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">   * when an async-wait is requested, the user can simply `hndl_of_interest-&gt;async_wait(..., F)`; `F()` will</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">   * be invoked directly within the user&#39;s event loop.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">   *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">   * (By contrast: if the user means to merely `poll(fd)` or `epoll_wait(fd)`, then they would simply do:</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   * `auto fd = hndl_of_interest-&gt;native_handle().m_native_handle`.  In this case the associated execution</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">   * context/executor of `*hndl_of_interest` is of zero import.)</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">   *</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   * This is a standard `sync_io`-pattern API per util::sync_io doc header.</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">   *</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment">   * @tparam Create_ev_wait_hndl_func</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">   *         Function type matching signature `util::sync_io::Asio_waitable_native_handle F()`.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">   * @param create_ev_wait_hndl_func</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">   *        See above.  Must return object `X` such that `X.is_open() == false` (i.e., storing no native handle/FD).</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">   * @return `false` -- indicating no-op, logging aside -- if and only if `start_*_ops()` has been called already.</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   *         `true` indicating success.  Note that this method should succeed even in NULL state.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   */</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Create_ev_wait_hndl_func&gt;</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#abe6227dfa077571d6eed2707532e4360">  147</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#abe6227dfa077571d6eed2707532e4360">replace_event_wait_handles</a>(<span class="keyword">const</span> Create_ev_wait_hndl_func&amp; create_ev_wait_hndl_func);</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"></span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   * Sets up the `sync_io`-pattern interaction between `*this` and the user&#39;s event loop; required before</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   * send_native_handle(), async_end_sending(), end_sending(), auto_ping() will work (as opposed to no-op/return</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * `false`).</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   *</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   * `ev_wait_func()` -- with signature matching util::sync_io::Event_wait_func -- is a key function memorized</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   * by `*this`.  It shall be invoked by `*this` operations when some op cannot complete synchronously and requires</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * a certain event (readable/writable) to be active on a certain native-handle.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   *</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment">   * @see util::sync_io::Event_wait_func doc header for useful and complete instructions on how to write an</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment">   *      `ev_wait_func()` properly.  Doing so correctly is the crux of using the `sync_io` pattern.</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">   *</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   * This is a standard `sync_io`-pattern API per util::sync_io doc header.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   *</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">   * @tparam Event_wait_func_t</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   *         Function type matching util::sync_io::Event_wait_func.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">   * @return `false` if this (or equivalent) has already been invoked; no-op logging aside.  `true` otherwise.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">   */</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Event_wait_func_t&gt;</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c34b110850c736c45d88689ab06c27c">  170</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c34b110850c736c45d88689ab06c27c">start_send_native_handle_ops</a>(Event_wait_func_t&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span>  <span class="comment">// General API (mirrors transport:: counterpart).</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"></span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">   */</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#afde03d7fb5746e77524229d5881b8d79">  178</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#afde03d7fb5746e77524229d5881b8d79">send_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"></span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">   * In PEER state: Synchronously, non-blockingly sends one discrete message, reliably/in-order, to the opposing peer;</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   * the message consists of the provided native handle (if supplied); or the provided binary blob (if supplied);</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment">   * or both (if both supplied).  The opposing peer&#39;s paired sync_io::Native_handle_receiver or</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment">   * transport::Native_handle_receiver shall receive it reliably and in-order via `async_receive_native_handle()`.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">   *</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   * Per `sync_io` pattern: if internally more work is required asynchronously pending 1+ native handles being</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   * in 1+ active-event (readable, writable) state, this method shall synchronously invoke the `Event_wait_func`</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   * registered via start_send_native_handle_ops() by the user of `*this`.</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   *</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   * If `*this` is not in PEER state (in particular if it is default-cted or moved-from), returns `false` immediately</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   * instead and otherwise no-ops (logging aside).</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   *</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   * Providing neither a handle nor a blob results in undefined behavior (assertion may trip).</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment">   * To *not* supply a handle, provide object with `.null() == true`.  To *not* supply a blob, provide</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment">   * a buffer with `.size() == 0`.</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">   *</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">   * ### Blob copying behavior; synchronicity/blockingness guarantees ###</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">   *</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">   * ### Error semantics ###</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">   *</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment">   * You may call this from any thread.  It is *not* required to be safe to call concurrently with</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment">   * any Native_handle_sender API, including this one and the destructor, invoked on `*this`.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">   *</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   * @param meta_blob</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   * @return Same notes as for transport::Native_handle_sender.  In addition: return `false` if</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   *         start_send_native_handle_ops() has not been called successfully.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   */</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a0f8f3fb816c09dd9a992a878892bbffb">  216</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a0f8f3fb816c09dd9a992a878892bbffb">send_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; meta_blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"></span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   * Equivalent to send_native_handle() but sends a graceful-close message instead of the usual payload; the opposing</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   * peer&#39;s paired sync_io::Native_handle_receiver or transport::Native_handle_receiver shall receive it reliably</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   * and in-order via `async_receive_native_handle()` in the form of</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   * #Error_code = error::Code::S_RECEIVES_FINISHED_CANNOT_RECEIVE.  If invoked after already invoking</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   * `*end_sending()`, the method shall no-op and return `false` and neither an exception nor truthy</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * `*err_code`.  Otherwise it shall return `true` -- but potentially emit a truthy #Error_code (if an error is</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   * detected).</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   *</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   * Informally one should think of async_end_sending() as just another message, which is queued after</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * preceding ones; but: it is the *last* message to be queued by definition.  It&#39;s like an EOF or a TCP-FIN.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   *</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   * Per `sync_io` pattern: if internally more work is required asynchronously pending 1+ native handles being</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   * in 1+ active-event (readable, writable) state, this method shall later invoke the `Event_wait_func`</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   * registered via start_send_native_handle_ops() by the user of `*this`; and the error code</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   * error::Code::S_SYNC_IO_WOULD_BLOCK shall be emitted here synchronously (via `*sync_err_code` if not null,</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   * exception if null -- per standard `flow::Error_code`-doc-header semantics).  Meanwhile the completion handler</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   * `on_done_func()` shall execute once the required async-waits have been satisfied</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   * by the `*this` user, synchronously from inside the `(*on_active_ev_func)()` call that achieves this state.</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   *</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   * If, by contrast, no more work is required -- the operation completed synchronously within this method -- then:</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   * success or error *other than* error::code::S_SYNC_IO_WOULD_BLOB shall be emitted (again per standard</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   * semantics) synchronously, and `on_done_func()` shall not be saved nor ever executed by `*this`.</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * Thus the result of the operation shall be either output directly synchronously -- if op completed synchronously --</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   * or later via `on_done_func()` completion handler.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   * Informally:</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   *   - emission of *not* `S_SYNC_IO_WOULD_BLOCK` is analogous to `SSL_write()` *not* returning</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *     `SSL_ERROR_WANT_*`.  The operation completed.</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   *   - emission of `S_SYNC_IO_WOULD_BLOCK` is analogous to `SSL_write()` returning</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   *     `SSL_ERROR_WANT_*`.  The operation requires an underlying transport to reach a certain readable/writable</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   *     state before `SSL_write()` can complete.</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   *</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   * In addition: if `*this` is not in PEER state (in particular if it is default-cted or moved-from), returns</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * `false` immediately instead and otherwise no-ops (logging aside).</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   *</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * ### Error semantics ###</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * Same notes as for transport::Native_handle_sender.  Exception: error may be emitted synchronously.</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * Exception: error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER shall not be emitted.</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * The notes for send_native_handle() apply.</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   *</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   * The semantic re. calling `*end_sending()` after already having called it and having that exclusively</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   * return `false` and do nothing was a judgment call.  As of this writing there&#39;s a long-ish comment at the top of</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * of `&quot;sync_io::Native_socket_stream::Impl::*end_sending()&quot;`&quot; body discussing why I (ygoldfel) went that way.</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   * @endinternal</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   *</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   *         Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   *        Do realize error::Code::S_SYNC_IO_WOULD_BLOCK *is* still an error, so if this pointer is null, then</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   *        would-block *will* make this throw.</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.  Plus see above.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * @return Same notes as for transport::Native_handle_sender.  In addition: return `false` if</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   *         start_send_native_handle_ops() has not been called successfully.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   */</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a9b99e18949cf819bfae4e08e44744fc6">  279</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a9b99e18949cf819bfae4e08e44744fc6">async_end_sending</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, Task_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment"></span> </div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * Equivalent to `async_end_sending(&amp;E, F)` wherein `F()` does nothing, and `E` is some `Error_code` &quot;sink&quot;</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   * ignored by the caller.</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   *</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   * Informally: ...Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   *</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * @return Same as in async_end_sending().</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   */</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c60142c23bf70bc3722d557ad309d58">  289</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c60142c23bf70bc3722d557ad309d58">end_sending</a>();</div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment"></span> </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * In PEER state: Irreversibly enables periodic auto-pinging of opposing receiver with low-level messages that</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * are ignored except that they reset any idle timer as enabled via sync_io::Native_handle_receiver::idle_timer_run()</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * or transport::Native_handle_receiver::idle_timer_run() (or similar).  As to the behavior of auto-pings:</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   *</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * Per `sync_io` pattern: if internally more work is required asynchronously pending 1+ native handles being</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * in 1+ active-event (readable, writable) state, this method shall synchronously invoke the `Event_wait_func`</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * registered via start_send_native_handle_ops() by the user of `*this`.</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   *   - In *this* case the events waited-on are likely to be the periodic firing of an internal auto-ping timer.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *     Therefore the correct auto-pinging behavior shall occur if and only if the user heeds the `sync_io` pattern:</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   *     async-wait when requested, report resulting events when they occur.</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   *</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * If `*this` is not in PEER state (in particular if it is default-cted or moved-from), returns `false` immediately</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * instead and otherwise no-ops (logging aside).  If auto_ping() has already been called successfuly,</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   * subsequently it will return `false` and no-op (logging aside).  If `*end_sending()` has been called succesfully,</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   * auto_ping() will return `false` and no-op (logging side).</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   *</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   * ### Behavior past `*end_sending()` ###</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   * Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   *</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * The notes for send_native_handle() apply.</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   *</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   * @param period</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   *        Same notes as for transport::Native_handle_sender.</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   * @return Same notes as for transport::Native_handle_sender.  In addition: return `false` if</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   *         start_send_native_handle_ops() has not been called successfully.</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   */</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a5b90444b333091c3e44d01b8cb07a499">  320</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a5b90444b333091c3e44d01b8cb07a499">auto_ping</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> period = default_value);</div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span>}; <span class="comment">// class Native_handle_sender</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment"></span> </div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">/**</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment"> * A documentation-only *concept* defining the behavior of an object that is the `sync_io`-pattern counterpart</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment"> * of the async-I/O-pattern-following concept of the same name in our parent namespace:</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment"> * transport::Native_handle_receiver.  This is paired with the sync_io::Native_handle_sender concept which defines</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment"> * sending of such messages.</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment"> *</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment"> * ### Concept contents ###</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment"> * The concept defines the behaviors/requirements mirroring those of sync_io::Native_handle_sender.</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment"> * Notes from that doc header apply similarly; except that among the `sync_io`-specific method names replace</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment"> * `send_native_handle` fragment of method names with `receive_native_handle`.</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment"> *</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment"> * @note The &quot;Thread safety&quot; section most definitely applies.  You should read it.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment"> *</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment"> * @see Native_socket_stream: as of this writing one key class that implements this concept (and also</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment"> *      sync_io::Native_handle_sender) -- using the Unix domain socket transport.</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment"> */</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">  339</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span>{</div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment"></span> </div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">  /// Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a80df90c9339c244230ec407ea258876b">  345</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a80df90c9339c244230ec407ea258876b">S_RESOURCE_TYPE_ID</a>;</div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment"></span> </div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">  /// Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aeb80b0f432a762a5c78ff19c8e32c0b9">  348</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aeb80b0f432a762a5c78ff19c8e32c0b9">S_META_BLOB_UNDERFLOW_ALLOWED</a> = value;</div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span> </div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment"></span> </div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   * Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   */</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a4d1ef7666fc35e98ced97abdc131a345">  356</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a4d1ef7666fc35e98ced97abdc131a345">Native_handle_receiver</a>();</div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment"></span> </div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * Move-constructs from `src`; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *        Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   */</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9e32e2a96c2dad89f9ccab34c96e545c">  365</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9e32e2a96c2dad89f9ccab34c96e545c">Native_handle_receiver</a>(<a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp;&amp; src);</div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment"></span> </div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">  /// Disallow copying.</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#af97ff850390e2d912a47bd9b2ef1f3d2">  368</a></span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#af97ff850390e2d912a47bd9b2ef1f3d2">Native_handle_receiver</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment"></span> </div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state, and if it&#39;s</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * still active) and return resources to OS as applicable.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   */</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9b464ca1d564e19340221e9958a5aa45">  374</a></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9b464ca1d564e19340221e9958a5aa45">~Native_handle_receiver</a>();</div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span> </div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment"></span> </div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * Move-assigns from `src`; `*this` acts as if destructed; `src` becomes as-if default-cted (therefore in NULL state).</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * No-op if `&amp;src == this`.  Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * @param src</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   *        Same notes as for transport::Native_handle_receiver.</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * @return `*this`.</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   */</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#affab55066b90fa3a69085678946da02e">  386</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#affab55066b90fa3a69085678946da02e">operator=</a>(<a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp;&amp; src);</div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment"></span> </div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">  /// Disallow copying.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aad1e12f7fbd213802c44d31ff7a2922c">  389</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp; <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aad1e12f7fbd213802c44d31ff7a2922c">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">Native_handle_receiver</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span> </div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span>  <span class="comment">// `sync_io`-pattern API.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment"></span> </div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * Coincides with sync_io::Native_handle_sender concept counterpart.</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   *</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * @tparam Create_ev_wait_hndl_func</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @param create_ev_wait_hndl_func</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   */</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Create_ev_wait_hndl_func&gt;</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6b26e7ee8f63e8e80b9cc7010bf208d6">  403</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6b26e7ee8f63e8e80b9cc7010bf208d6">replace_event_wait_handles</a>(<span class="keyword">const</span> Create_ev_wait_hndl_func&amp; create_ev_wait_hndl_func);</div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment"></span> </div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   * Sets up the `sync_io`-pattern interaction between `*this` and the user&#39;s event loop; required before</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   * async_receive_native_handle(), idle_timer_run() will work (as opposed to no-op/return</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   * `false`).</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   *</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">   * Otherwise the notes for sync_io::Native_handle_receiver::start_send_native_handle_ops() apply equally.</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   *</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * @tparam Event_wait_func_t</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   */</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Event_wait_func_t&gt;</div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aa55c06ebb8ba1ba262560eabadb09ab6">  419</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aa55c06ebb8ba1ba262560eabadb09ab6">start_receive_native_handle_ops</a>(Event_wait_func_t&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span> </div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span>  <span class="comment">// General API (mirrors transport:: counterpart).</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment"></span> </div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   * Mirrors sync_io::Native_handle_sender::send_meta_blob_max_size().</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   */</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a46194b54e9465a5a41d7fedf9d4982ae">  427</a></span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a46194b54e9465a5a41d7fedf9d4982ae">receive_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment"></span> </div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   * In PEER state: Possibly-asynchronously awaits one discrete message -- as sent by the opposing peer via</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * Native_handle_sender::send_native_handle() or `&quot;Native_handle_sender::*end_sending()&quot;` -- and</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * receives it into the given target locations, reliably and in-order.  The message is, therefore, one of the</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * following:</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   *   - A binary blob; a native handle; or both.  This is indicated by `on_done_func(Error_code(), N)` or</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   *     the equivalent synchronous out-args (see below on that topic).</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   *     The falsy code indicates success; `N &lt;= target_meta_blob.size()` indicates the number of bytes received into</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   *     `target_meta_blob.data()` (zero means no blob was sent in the message).  `*target_hndl` is set</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   *     (`target_hndl-&gt;null() == true` means no handle was sent in the message).</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   *   - Graceful-close.  This is indicated by `on_done_func(error::code::S_RECEIVES_FINISHED_CANNOT_RECEIVE, 0)` or</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   *     the equivalent synchronous out-args (see below on that topic).</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   *     Neither the target blob nor target native handle are touched.</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   *</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * Per `sync_io` pattern: if internally more work is required asynchronously pending 1+ native handles being</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * in 1+ active-event (readable, writable) state, this method shall later invoke the `Event_wait_func`</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   * registered via start_receive_native_handle_ops() by the user of `*this`; and the error code</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   * error::Code::S_SYNC_IO_WOULD_BLOCK shall be emitted here synchronously (via `*sync_err_code` if not null,</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   * exception if null -- per standard `flow::Error_code`-doc-header semantics).  Meanwhile the completion handler</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   * `on_done_func()` shall execute once the required async-waits have been satisfied</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   * by the `*this` user, synchronously from inside the `(*on_active_ev_func)()` call that achieves this state.</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   *</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   * If, by contrast, no more work is required -- the operation completed synchronously within this method -- then:</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   * success or error *other than* error::code::S_SYNC_IO_WOULD_BLOB shall be emitted (again per standard</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   * semantics) synchronously; `*sync_sz` is set to 0 or bytes-transmitted, and `on_done_func()` shall not be</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * saved nor ever executed by `*this`.  Thus the result of the operation shall be either output directly</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   * synchronously -- if op completed synchronously -- or later via `on_done_func()` completion handler.</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   *</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   * Informally:</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">   *   - emission of *not* `S_SYNC_IO_WOULD_BLOCK` is analogous to `SSL_read()` *not* returning</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment">   *     `SSL_ERROR_WANT_*`.  The operation completed.</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">   *   - emission of `S_SYNC_IO_WOULD_BLOCK` is analogous to `SSL_read()` returning</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">   *     `SSL_ERROR_WANT_*`.  The operation requires an underlying transport to reach a certain readable/writable</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   *     state before `SSL_read()` can complete.</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   *</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * In addition: if `*this` is not in PEER state (in particular if it is default-cted or moved-from), returns</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   * `false` immediately instead and otherwise no-ops (logging aside).  Same if the preceding `async_receive_*()`</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   * to have returned `true` has not yet executed its completion handler or synchronously completed.</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   *</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * ### Error semantics ###</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   * Same notes as for transport::Native_handle_receiver.  Exception: error may be emitted synchronously.</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * Exception: error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER shall not be emitted.</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   *</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   * @tparam Task_err_sz</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   *         A functor type with signature identical to `flow::async::Task_asio_err_sz`.</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   * @param target_hndl</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   *        `*target_hndl` shall be set before `on_done_func()` is executed with a falsy code.</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   * @param target_meta_blob</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   *        `target_meta_blob.data()...` shall be written to before `on_done_func()` is executed with a falsy</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *        code, bytes numbering `N`, where `N` is passed to that callback.  `N` shall not exceed</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   *        `target_meta_blob.size()`.  See &quot;Error semantics&quot; (there is an `Error_code` regarding</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   *        overflowing the user&#39;s memory area).</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   *        Do realize error::Code::S_SYNC_IO_WOULD_BLOCK *is* still an error, so if this pointer is null, then</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   *        would-block *will* make this throw.</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   *        See above.  If null behavior undefined (assertion may trip).</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * @return Same notes as for transport::Native_handle_receiver.  In addition: return `false` if</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *         start_receive_native_handle_ops() has not been called successfully, or if the preceding</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   *         async-receive has not completed (completion handler has not executed).</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   */</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err_sz&gt;</div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6350bfb7f929a5b60fa4af1b6f7166cf">  494</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6350bfb7f929a5b60fa4af1b6f7166cf">async_receive_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl,</div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span>                                   <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span> sync_sz,</div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span>                                   <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span>                                   Task_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment"></span> </div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   * In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is, once at least</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * the specified time has passed since the last received low-level traffic (or this call, whichever most</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   * recently occurred), to emit the pipe-hosing error error::Code::S_RECEIVER_IDLE_TIMEOUT.  The implementation</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   * shall guarantee the observer idle timeout is at least the provided value but may exceed this value for</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * internal reasons, as long as it&#39;s by a less than human-perceptible period (roughly speaking -- milliseconds,</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * not seconds).</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   *</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   * Per `sync_io` pattern: if internally more work is required asynchronously pending 1+ native handles being</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   * in 1+ active-event (readable, writable) state, this method shall synchronously invoke the `Event_wait_func`</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   * registered via start_send_native_handle_ops() by the user of `*this`.</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   *   - In *this* case the events waited-on are likely to be at most 1 (per PEER state) firing of an internal</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   *     idle timer.</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   *     - Indeed if that does occur, the `(*on_active_ev_func)()` call (by the `*this` user) that reported</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   *       the timer firing shall also act as-if the currently pending async_receive_native_handle() (if any)</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   *       encountered the pipe-hosing error error::Code::S_RECEIVER_IDLE_TIMEOUT.</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   *       - No special code is necessary on the user&#39;s part to handle this: it will look like the</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   *         async_receive_native_handle() failing with a pipe-hosing error; which any proper</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   *         `on_done_func()` must handle anyway.</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   *</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   * If `*this` is not in PEER state (in particular if it is default-cted or moved-from), returns `false` immediately</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * instead and otherwise no-ops (logging aside).  If idle_timer_run() has already been called successfuly,</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   * subsequently it will return `false` and no-op (logging aside).</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   *</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * ### Important: Relationship between idle_timer_run() and async_receive_native_handle() ###</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   * Notes for transport::Native_handle_receiver apply.  In short: if you use idle_timer_run(), then you&#39;d best</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   * have an async_receive_native_handle() outstanding at ~all times.</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   *</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   * ### Error semantics ###</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   * If and only if the timeout does occur down the line, the aforementioned error will be emitted via</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   * async_receive_native_handle() (or similar) handler.  It shall be treated as the reason to hose the pipe</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * (assuming it was not hosed by something else earlier).</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   *</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   * ### Suggested use ###</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   * Notes for transport::Native_handle_receiver apply.</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   *</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   * @param timeout</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   *        Notes for transport::Native_handle_receiver apply.</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   * @return Same notes as for transport::Native_handle_receiver.  In addition: return `false` if</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   *         start_receive_native_handle_ops() has not been called successfully.</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   */</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a57ec0f2a9c1b8bfbaaf88975433a1354">  540</a></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a57ec0f2a9c1b8bfbaaf88975433a1354">idle_timer_run</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout = default_value);</div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span>}; <span class="comment">// class Native_handle_receiver</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span> </div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span>} <span class="comment">// namespace ipc::transport::sync_io</span></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html">ipc::transport::sync_io::Native_handle_receiver</a></div><div class="ttdoc">A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__handle__transport_8hpp_source.html#l00339">native_handle_transport.hpp:340</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a46194b54e9465a5a41d7fedf9d4982ae"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a46194b54e9465a5a41d7fedf9d4982ae">ipc::transport::sync_io::Native_handle_receiver::receive_meta_blob_max_size</a></div><div class="ttdeci">size_t receive_meta_blob_max_size() const</div><div class="ttdoc">Mirrors sync_io::Native_handle_sender::send_meta_blob_max_size().</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a4d1ef7666fc35e98ced97abdc131a345"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a4d1ef7666fc35e98ced97abdc131a345">ipc::transport::sync_io::Native_handle_receiver::Native_handle_receiver</a></div><div class="ttdeci">Native_handle_receiver()</div><div class="ttdoc">Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a57ec0f2a9c1b8bfbaaf88975433a1354"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a57ec0f2a9c1b8bfbaaf88975433a1354">ipc::transport::sync_io::Native_handle_receiver::idle_timer_run</a></div><div class="ttdeci">bool idle_timer_run(util::Fine_duration timeout=default_value)</div><div class="ttdoc">In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is,...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a6350bfb7f929a5b60fa4af1b6f7166cf"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6350bfb7f929a5b60fa4af1b6f7166cf">ipc::transport::sync_io::Native_handle_receiver::async_receive_native_handle</a></div><div class="ttdeci">bool async_receive_native_handle(Native_handle *target_hndl, Error_code *sync_err_code, size_t sync_sz, const util::Blob_mutable &amp;target_meta_blob, Task_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">In PEER state: Possibly-asynchronously awaits one discrete message – as sent by the opposing peer via...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a6b26e7ee8f63e8e80b9cc7010bf208d6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a6b26e7ee8f63e8e80b9cc7010bf208d6">ipc::transport::sync_io::Native_handle_receiver::replace_event_wait_handles</a></div><div class="ttdeci">bool replace_event_wait_handles(const Create_ev_wait_hndl_func &amp;create_ev_wait_hndl_func)</div><div class="ttdoc">Coincides with sync_io::Native_handle_sender concept counterpart.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a80df90c9339c244230ec407ea258876b"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a80df90c9339c244230ec407ea258876b">ipc::transport::sync_io::Native_handle_receiver::S_RESOURCE_TYPE_ID</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID</div><div class="ttdoc">Same notes as for transport::Native_handle_receiver.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__handle__transport_8hpp_source.html#l00345">native_handle_transport.hpp:345</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a9b464ca1d564e19340221e9958a5aa45"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9b464ca1d564e19340221e9958a5aa45">ipc::transport::sync_io::Native_handle_receiver::~Native_handle_receiver</a></div><div class="ttdeci">~Native_handle_receiver()</div><div class="ttdoc">Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state,...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_a9e32e2a96c2dad89f9ccab34c96e545c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#a9e32e2a96c2dad89f9ccab34c96e545c">ipc::transport::sync_io::Native_handle_receiver::Native_handle_receiver</a></div><div class="ttdeci">Native_handle_receiver(Native_handle_receiver &amp;&amp;src)</div><div class="ttdoc">Move-constructs from src; src becomes as-if default-cted (therefore in NULL state).</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_aa55c06ebb8ba1ba262560eabadb09ab6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aa55c06ebb8ba1ba262560eabadb09ab6">ipc::transport::sync_io::Native_handle_receiver::start_receive_native_handle_ops</a></div><div class="ttdeci">bool start_receive_native_handle_ops(Event_wait_func_t &amp;&amp;ev_wait_func)</div><div class="ttdoc">Sets up the sync_io-pattern interaction between *this and the user's event loop; required before asyn...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_aad1e12f7fbd213802c44d31ff7a2922c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aad1e12f7fbd213802c44d31ff7a2922c">ipc::transport::sync_io::Native_handle_receiver::operator=</a></div><div class="ttdeci">Native_handle_receiver &amp; operator=(const Native_handle_receiver &amp;)=delete</div><div class="ttdoc">Disallow copying.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_aeb80b0f432a762a5c78ff19c8e32c0b9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#aeb80b0f432a762a5c78ff19c8e32c0b9">ipc::transport::sync_io::Native_handle_receiver::S_META_BLOB_UNDERFLOW_ALLOWED</a></div><div class="ttdeci">static constexpr bool S_META_BLOB_UNDERFLOW_ALLOWED</div><div class="ttdoc">Same notes as for transport::Native_handle_receiver.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__handle__transport_8hpp_source.html#l00348">native_handle_transport.hpp:348</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_af97ff850390e2d912a47bd9b2ef1f3d2"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#af97ff850390e2d912a47bd9b2ef1f3d2">ipc::transport::sync_io::Native_handle_receiver::Native_handle_receiver</a></div><div class="ttdeci">Native_handle_receiver(const Native_handle_receiver &amp;)=delete</div><div class="ttdoc">Disallow copying.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__receiver_html_affab55066b90fa3a69085678946da02e"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__receiver.html#affab55066b90fa3a69085678946da02e">ipc::transport::sync_io::Native_handle_receiver::operator=</a></div><div class="ttdeci">Native_handle_receiver &amp; operator=(Native_handle_receiver &amp;&amp;src)</div><div class="ttdoc">Move-assigns from src; *this acts as if destructed; src becomes as-if default-cted (therefore in NULL...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html">ipc::transport::sync_io::Native_handle_sender</a></div><div class="ttdoc">A documentation-only concept defining the behavior of an object that is the sync_io-pattern counterpa...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__handle__transport_8hpp_source.html#l00073">native_handle_transport.hpp:74</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a0f8f3fb816c09dd9a992a878892bbffb"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a0f8f3fb816c09dd9a992a878892bbffb">ipc::transport::sync_io::Native_handle_sender::send_native_handle</a></div><div class="ttdeci">bool send_native_handle(Native_handle hndl_or_null, const util::Blob_const &amp;meta_blob, Error_code *err_code=0)</div><div class="ttdoc">In PEER state: Synchronously, non-blockingly sends one discrete message, reliably/in-order,...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a59dff09b6ab224e32a096c97b629d059"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a59dff09b6ab224e32a096c97b629d059">ipc::transport::sync_io::Native_handle_sender::~Native_handle_sender</a></div><div class="ttdeci">~Native_handle_sender()</div><div class="ttdoc">Destroys this peer endpoint which will end the conceptual outgoing-direction pipe (in PEER state,...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a5b90444b333091c3e44d01b8cb07a499"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a5b90444b333091c3e44d01b8cb07a499">ipc::transport::sync_io::Native_handle_sender::auto_ping</a></div><div class="ttdeci">bool auto_ping(util::Fine_duration period=default_value)</div><div class="ttdoc">In PEER state: Irreversibly enables periodic auto-pinging of opposing receiver with low-level message...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a624a0c63efc9487cea6da342be38d9a7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a624a0c63efc9487cea6da342be38d9a7">ipc::transport::sync_io::Native_handle_sender::S_RESOURCE_TYPE_ID</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID</div><div class="ttdoc">Same notes as for transport::Native_handle_sender.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__handle__transport_8hpp_source.html#l00079">native_handle_transport.hpp:79</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a8c34b110850c736c45d88689ab06c27c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c34b110850c736c45d88689ab06c27c">ipc::transport::sync_io::Native_handle_sender::start_send_native_handle_ops</a></div><div class="ttdeci">bool start_send_native_handle_ops(Event_wait_func_t &amp;&amp;ev_wait_func)</div><div class="ttdoc">Sets up the sync_io-pattern interaction between *this and the user's event loop; required before send...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a8c60142c23bf70bc3722d557ad309d58"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a8c60142c23bf70bc3722d557ad309d58">ipc::transport::sync_io::Native_handle_sender::end_sending</a></div><div class="ttdeci">bool end_sending()</div><div class="ttdoc">Equivalent to async_end_sending(&amp;E, F) wherein F() does nothing, and E is some Error_code &quot;sink&quot; igno...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a935bfba8ac18f395eb920224395cbc8f"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a935bfba8ac18f395eb920224395cbc8f">ipc::transport::sync_io::Native_handle_sender::Native_handle_sender</a></div><div class="ttdeci">Native_handle_sender()</div><div class="ttdoc">Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_a9b99e18949cf819bfae4e08e44744fc6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#a9b99e18949cf819bfae4e08e44744fc6">ipc::transport::sync_io::Native_handle_sender::async_end_sending</a></div><div class="ttdeci">bool async_end_sending(Error_code *sync_err_code, Task_err &amp;&amp;on_done_func)</div><div class="ttdoc">Equivalent to send_native_handle() but sends a graceful-close message instead of the usual payload; t...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_aa67027b6f36ea618586cd24028f5025f"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa67027b6f36ea618586cd24028f5025f">ipc::transport::sync_io::Native_handle_sender::operator=</a></div><div class="ttdeci">Native_handle_sender &amp; operator=(const Native_handle_sender &amp;)=delete</div><div class="ttdoc">Disallow copying.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_aa739a0a76b4e0325c4067d5a5b55a802"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa739a0a76b4e0325c4067d5a5b55a802">ipc::transport::sync_io::Native_handle_sender::operator=</a></div><div class="ttdeci">Native_handle_sender &amp; operator=(Native_handle_sender &amp;&amp;src)</div><div class="ttdoc">Move-assigns from src; *this acts as if destructed; src becomes as-if default-cted (therefore in NULL...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_aa99ee4ded3b81cbaea9cb7aeac52a896"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#aa99ee4ded3b81cbaea9cb7aeac52a896">ipc::transport::sync_io::Native_handle_sender::Native_handle_sender</a></div><div class="ttdeci">Native_handle_sender(Native_handle_sender &amp;&amp;src)</div><div class="ttdoc">Move-constructs from src; src becomes as-if default-cted (therefore in NULL state).</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_abe6227dfa077571d6eed2707532e4360"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#abe6227dfa077571d6eed2707532e4360">ipc::transport::sync_io::Native_handle_sender::replace_event_wait_handles</a></div><div class="ttdeci">bool replace_event_wait_handles(const Create_ev_wait_hndl_func &amp;create_ev_wait_hndl_func)</div><div class="ttdoc">To be (optionally) invoked before any start_*_ops(), supplies a factory for the util::sync_io::Asio_w...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_af3efe9a668e251175e5e199e99f9257d"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#af3efe9a668e251175e5e199e99f9257d">ipc::transport::sync_io::Native_handle_sender::Native_handle_sender</a></div><div class="ttdeci">Native_handle_sender(const Native_handle_sender &amp;)=delete</div><div class="ttdoc">Disallow copying.</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__handle__sender_html_afde03d7fb5746e77524229d5881b8d79"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__handle__sender.html#afde03d7fb5746e77524229d5881b8d79">ipc::transport::sync_io::Native_handle_sender::send_meta_blob_max_size</a></div><div class="ttdeci">size_t send_meta_blob_max_size() const</div><div class="ttdoc">Same notes as for transport::Native_handle_sender.</div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1sync__io_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1sync__io.html">ipc::transport::sync_io</a></div><div class="ttdoc">sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2transport__fwd_8hpp_source.html#l00069">transport_fwd.hpp:70</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ac66141280c3b7295a86b65209f31cc58"><div class="ttname"><a href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">ipc::util::Fine_duration</a></div><div class="ttdeci">flow::Fine_duration Fine_duration</div><div class="ttdoc">Short-hand for Flow's Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00117">util_fwd.hpp:117</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
